Insert a value at the specified index. Any elements previously occurring at and after the specified index have their indices increased by 1, and the size of the list increases by 1.

Note that for a list my_list:

my_list.add(my_list.size(), x) "appends" x to the end of the list
my_list.add(my_list.size() + 1, x) throws an exception

Note also that my_list.add(my_list.size(), x) is equivalent to my_list.add(x) (inherited from collection<T>).

add_all

function add_all(values: collection<-T>): boolean

Add all elements from another collection to the end of this collection.

If this collection does not allow duplicates, then only those elements not already contained in this collection are added.

function add_all(index: integer, values: collection<-T>): boolean

Insert all elements from a collection at the specified index. Any elements previously occurring at and after the specified index have their indices increased by the size of the given collection. The size of the list increases by the size of the given collection.

Note that for a list my_list:

my_list.add_all(my_list.size(), x) "appends" the elements of the collection x to the end of the list
my_list.add_all(my_list.size() + 1, x) throws an exception

Note also that my_list.add_all(my_list.size(), x) is equivalent to my_list.add_all(x) (inherited from collection<T>).

addAll

(alias) function ~~addAll~~(values: collection<-T>): boolean

Add all elements from another collection to the end of this collection.

If this collection does not allow duplicates, then only those elements not already contained in this collection are added.

Alias

add_all

(alias) function ~~addAll~~(index: integer, values: collection<-T>): boolean

Note that for a list my_list:

my_list.add_all(my_list.size(), x) "appends" the elements of the collection x to the end of the list
my_list.add_all(my_list.size() + 1, x) throws an exception

Note also that my_list.add_all(my_list.size(), x) is equivalent to my_list.add_all(x) (inherited from collection<T>).

Alias

add_all

clear

function clear()

Clear this collection; i.e. remove all its elements. Immediately after this method returns, this collection is empty.

contains

pure function contains(value: T): boolean

Check if this collection contains the given element.

contains_all

pure function contains_all(values: collection<-T>): boolean

Check if this collection contains all elements of another collection.

containsAll

(alias) pure function ~~containsAll~~(values: collection<-T>): boolean

Check if this collection contains all elements of another collection.

Alias

contains_all

empty

pure function empty(): boolean

Check if this collection is empty.

get

pure function get(index: integer): T

Retrieve the element at the specified index.

index_of

pure function index_of(value: T): integer

Search for the first occurrence of the specified element within this list.

indexOf

(alias) pure function ~~indexOf~~(value: T): integer

Search for the first occurrence of the specified element within this list.

Alias

index_of

join_to_text

pure function join_to_text([separator: text], [prefix: text], [postfix: text], [limit: integer?], [truncated: text], [transform: (T) -> text]): text

Generate a textual representation of this iterable.

An optional separator, prefix and postfix can be provided. One can also provide a limit: integer?. If there are more elements in the result than limit, the elements whose indices exceed limit are omitted, and the passed truncated: text is included instead.

Examples:

[1, 2, 3].join_to_text() returns '1, 2, 3'.
[1, 2, 3].join_to_text('_') returns '1_2_3'.
[1, 2, 3].join_to_text('*', '(', ')') returns '(1*2*3)'.
list<T>().join_to_text('!', '(', ')') returns '()' (where T is a valid type).
range(10).join_to_text('', '', '', 5) returns '01234...'.
range(10).join_to_text('', '', '', 5, 'more') returns '01234more'.

Where the function even is defined:

function even(x: integer): text {
   return if (x % 2 == 0) 'EVEN' else 'ODD';
}

Then:

range(10).join_to_text('->', '{', '}', 5, '...', even(*)) returns {EVEN->ODD->EVEN->ODD->EVEN->...}.

len

(alias) pure function ~~len~~(): integer

Get the size (number of elements) of this collection.

Alias

size

remove

function remove(value: T): boolean

Remove an element from this collection.

remove_all

function remove_all(values: collection<-T>): boolean

Remove all elements in another collection from this collection.

remove_at

function remove_at(index: integer): T

Remove and return the element at the specified index. The indices of elements occurring after the specified index decrease by 1, and the size of this list decreases by 1.

removeAll

(alias) function ~~removeAll~~(values: collection<-T>): boolean

Remove all elements in another collection from this collection.

Alias

remove_all

removeAt

(alias) function ~~removeAt~~(index: integer): T

Remove and return the element at the specified index. The indices of elements occurring after the specified index decrease by 1, and the size of this list decreases by 1.

Alias

remove_at

repeat

function repeat(n: integer): list<T>

Repeat this list n times.

Examples:

[1, 2, 3].repeat(3) returns [1, 2, 3, 1, 2, 3, 1, 2, 3]
list<T>().repeat(3) returns [] (for any type T)
[3].repeat(0) returns []

reverse

function reverse()

Reverses the order of the elements in the list in place.

Where this list is bound to the variable l, then the statement l.reverse(); is equivalent to l = l.reversed();.

reversed

function reversed(): list<T>

Returns a new list with the elements of this list in reverse order.

Examples:

[].reversed() returns []
[1].reversed() returns [1]
[1, 2, 3].reversed() returns [3, 2, 1]

set

function set(index: integer, value: T): T

Set the element at the specified index, overwriting the element that was previously at that index. The size of the list is unchanged.

size

pure function size(): integer

Get the size (number of elements) of this collection.

sort

function sort()

Sort this list in place.

sorted

pure function sorted(): list<T>

Sorts the elements of this collection into a list. This collection is not modified.

str

(alias) pure function str(): text

Returns a textual representation of this collection.

Alias

to_text

sub

pure function sub(start: integer): list<T>

Returns a sublist of this list starting from the specified index (inclusive).

Equivalent to list.sub(index, list.size()).

Note that:

my_list.sub(my_list.size() - 1) returns a list containing only the last element of my_list (assuming my_list.size > 0)
my_list.sub(my_list.size()) returns an empty list
my_list.sub(my_list.size() + 1) throws an exception

pure function sub(start: integer, end: integer): list<T>

Returns a sublist of this list starting from the specified start index (inclusive) to the specified end index (exclusive).

For the list my_list, my_list.sub(start, my_list.size()) is equivalent to my_list.sub(start).

to_text

pure function to_text(): text

Returns a textual representation of this collection.

list

Since

See also

Constructors

Functions